/* Copyright (c) 2006 by M Aamir Maniar 
 * 
 * Permission is hereby granted, free of charge, to any person obtaining 
 * a copy of this software and associated documentation files (the 
 * "Software"), to deal in the Software without restriction, including 
 * without limitation the rights to use, copy, modify, merge, publish, 
 * distribute, sublicense, and/or sell copies of the Software, and to 
 * permit persons to whom the Software is furnished to do so, subject to 
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 * */

namespace Generic.Algorithms.Sorting
{
    using System;
    using System.Collections.Generic;
    using System.Collections;
    using System.Text;
    using Generic.Utils;

    public interface ISortStrategy<T>
    {
        /// <summary>
        /// Sorts the list with applied sort strategy.
        /// </summary>
        void Sort();

        /// <summary>
        /// Sorts the list specified sort direction using applied sort strategy.
        /// </summary>
        /// <param name="sortDirection">The sort direction in which list to be sorted.</param>
        void Sort(SortDirection sortDirection);

        /// <summary>
        /// Sorts the list specified sort direction using applied sort strategy.
        /// </summary>
        /// <param name="comparision">The comparision delegate.</param>
        /// <param name="sortDirection">The sort direction.</param>
        void Sort(Comparison<T> comparision, SortDirection sortDirection);

        /// <summary>
        /// Gets or sets the list.
        /// </summary>
        /// <value>The list.</value>
        IList<T> List { get; set;}

        /// <summary>
        /// Gets or sets the Comparer.
        /// </summary>
        IComparer<T> Comparer { get; set; }

        /// <summary>
        /// Gets the comparisions count.
        /// </summary>
        /// <value>The comparisions count.</value>
        /// <remarks>
        /// Comparisions count variable helps benchmarking of sorting algorithm
        /// against given <see cref="T:List&lt;T&gt;"/>
        /// </remarks>
        int ComparisionsCount { get; }
    }
}
